qacli view
このサブコマンドは以前の解析による診断のサマリ出力を可能にします。
使用方法
view [-P <directory>] [-K <config name>] [-C <solution-name>] [-R] [-t <SUMMARY>] -m <HTML|STDERR|STDOUT|XML> [--output-name <filename prefix>] [-o <directory>] [-F <filelist>] [-X <max-count-filter>] [-S <0|1|2|3|4|5|6|7|8|9>] [-v <0|1|2|3|4|5|6|7|8|9>] [-N <msg-filter>] [-O <msg-filter>] [-D <NONE|SINGLE|DUPLICATE|CMA>] [-T <ALL|BASELINE|COMMENT|DASHBOARD|INTERACTIVE|MACRO|PRAGMA|VALIDATE>] ... [-Y] [-Z] [-n] [-i <indent>] [--] [-h] <source-file>
詳しい説明
view サブコマンドはさまざまな媒体（Text, XML, HTML）で解析結果の出力をすることを可能にします。 フィルタリングによりユーザは何の詳細を、どのファイルから取り出し出力するかを細かくコントロールすることができます。
--type (短縮形は-t )オプションを使用して出力の設定をします。使用可能な値：
出力は以下に示す形式（または、媒体）です。
- HTML: ソースファイルごとに結果を HTML ファイルに出力します。
- STDERR: 結果を text で出力します（標準エラー出力）。
- STDOUT: 結果を text で出力します（標準出力）。
- XML: ソースファイルごとに結果を XML ファイルに出力します。
コマンドラインで結果を表示したり、結果をファイルに出力したりすることができます。
オリジナルのソースは「読取りのみ」で、いかなる状況下でも、コマンドの如何によらず変更および、変更日時がかわることはありません。
オプションの短縮形は次のように連続記述することができます。例: qacli view -P <directory> -m STDOUT -rs
オプション
| 名前、短縮形 |
デフォルト |
説明 |
--config, -K |
|
複数の設定を持つプロジェクトに対しどの設定を使用するかを指定します。指定がない場合は、デフォルトが使用されます。 |
--cma-solution, --C |
|
クロスモジュール解析(CMA)ソリューションを表示するための名前を指定します。このオプションは、ソリューションで関与しているすべての Perforce QAC が表示されることを意味します。 解析（CMAソリューションの最初のPerforce QACプロジェクトがデフォルトで使用されます）の結果を表示するためのプロジェクトを指定するには、--qaf-project オプションを使用してください。 |
--exclude-zero-dependent-rust, -Y
|
|
デフォルトで診断数がゼロでないすべてのRustモジュールが出力されます。このオプションは診断のないRustの依存モジュールを出力から隠蔽します。 |
--files, -F
|
|
結果を表示することができるファイルのリストを含むファイルのパスを指定します。指定がない場合、プロジェクトに含まれているすべてのファイルの結果が表示されます。 |
--help, -h
|
|
使用方法の情報を表示し、終了します。 |
--ignore-rest, --
|
|
このフラグ以降のラベルの付いた引数をすべて無視します。 |
--include-zero-headers, -Z
|
|
デフォルトですべてのソースファイルが出力されますが、ゼロ以外の診断を伴うヘッダのみが表示されます。 このオプションは診断の件数に関係なくすべてのソースおよび、ヘッダファイルを表示します。 |
--indent, -i
|
-1 または 0 |
インデントの各レベルの出力に適用するスペースまたは、タブの数を設定します（XML）。 スペースには正の数字を、タブには負の数字を使用します。 XMLのデフォルト値は －1です。 |
--max-count, -X
|
|
メッセージが表示される回数を制限します。 デフォルトの0は、無制限が適用されることを示しています。 |
--max-severity, -v
|
|
設定されている重要度よりも高い重要度のメッセージをフィルタリングします。このオプションは指定された重要度の範囲内または、特定の重要度のメッセージのみを出力するために --min-severity オプションと併用することができます。9を指定することができますが、何もフィルタリングしません。 |
--min-severity, -S
|
|
設定されている重要度よりも低い重要度のメッセージをフィルタリングします。このオプションは指定された重要度の範囲内または、特定の重要度のメッセージのみを出力するために --max-severity オプションと併用することができます。0を指定することができますが、何もフィルタリングしません。 |
--medium, -m
|
|
結果を表示する媒体を指定します。 |
--multi-homed-format, -D
|
|
CMAからの診断結果など、multi-homed (homeless) の診断を表示するのに使用する形式を指定します。 使用可能な値:
- NONE: multi-homed (homeless) の診断を表示しない（デフォルト）
- DUPLICATE: 各ロケーションに各診断を複製する
- SINGLE: 単一ロケーションに各診断を出力する ただし、組込まれたヘッダを除くSUMMARY & DIAGLST
- CMA: CMA 'file'に出力。SUMMARY のみ
|
--nomsg, -N
|
|
指定したメッセージの表示を抑止します。メッセージ番号は、下の例のように、個々に指定することも、リストもしくは範囲の形で、または両者を組み合わせて指定することもできます。 --nomsg 2356 --nomsg 1234,1236,1240 --nomsg 2111,2200-2300 |
--no-header-messages, -n
|
|
これを指定すると、ヘッダファイルからの診断を表示しません。 |
--only, -O
|
|
指定された警告メッセージのみが表示さされます。 メッセージ番号は、下の例のように、個々に指定することも、リストもしくは範囲の形で、または両者を組み合わせて指定することもできます。 --only 2356 --only 1234,1236,1240 --only 2111,2200-2300 |
--output-name
|
|
-t SUMMARY -m XMLと ファイル名に接頭辞をつけ、単一のファイルを生成するコマンドに使用します。 これによりファイル名のカスタマイズをすることができます。 |
--output-path, -o
|
|
出力されたファイルを格納するため、書き込みアクセス権限を持つ既存のディレクトリへのパスを指定します。
このオプションは、媒体 のオプションが HTMLまたは、XML に設定されている場合のみ有効になります。 重複しているファイルは上書きされず、そのファイル名は元のファイル名に一意的な番号を追加したものになります。
|
--qaf-project, -P
|
|
結果を表示するため、有効な Perforce QAC プロジェクトへのパスを指定します。 |
--relative-paths, -R
|
|
これを指定すると、ソースファイルはソースルートフォルダへの相対部分のみを表示します。 |
--suppression-filter, -r
|
|
抑止された診断メッセージのどれをフィルタに通すかを指定します。
使用可能なオプションは: ALL, BASELINE, COMMENT, DASHBOARD, INTERACTIVE, MACRO, PRAGMA, and VALIDATEです。
フォーマット指定子 '抑止の理由'(%j) は、ユーザがこのオプションを選択した場合のみ読込まれます。 DASHBOARD および、VALIDATE はINTERACTIVEと同義とです。
|
--type, -t
|
SUMMARY |
以下に結果を表示する形式を指定します。
- SUMMARY: 各重要度レベルの詳細な診断のサマリテーブル
|
例
Perforce QAC プロジェクトの結果を標準出力するには、以下のコマンドを実行します。
qacli view -P <directory> --type SUMMARY --medium STDOUT
標準エラーに出力する場合は、上記のコマンドのSTDOUT を STDERR に置き換えます。
--medium オプションの引数を HTMLまたは、XML に設定すると、ディレクトリを指定できます。ファイルはそのディレクトリに出力されます。
qacli view -P <directory> -m HTML --output-path <directory>
ディレクトリは既存していなければなりません。
重要度サマリ (SUMMARY)
プロジェクトの簡潔な重要度サマリの出力には、--type SUMMARYを使用します。 例:
qacli view -P <directory> -m STDOUT --type SUMMARY
このコマンドで、コンソールにサマリを出力しますが、必要に応じてファイルに出力先を変更することができます。
もちろんHTMLファイル、XMLファイルへ出力することもできます。 デフォルトのファイル名は、 severity_summary.xml (または .html) で、現在使用中の作業ディレクトリに出力されます。
他のディレクトリに出力するには、 --output-pathを使用します。例:
qacli view -P <directory> -m XML --type SUMMARY --output-path ../frodo
特定の名前の付いたファイルに出力する場合は、--output-nameを使用します。 例:
qacli view -P <directory> -m XML --type SUMMARY --output-name My_Sev_Summary
適切な拡張子 (.xml または .html) は自動的に加えられます。 出力ファイルの厳密な位置と名前を指示するために--output-path 、--output-name の両方を同時に使用することができます。
XML形式の出力には、出力形式を記述する追加のスキーマも生成されます。 このファイル名は、cli_view_severity_summary.xsdです。
マルチプロジェクトCMAソリューションには、各プロジェクトに対し１つのファイルが生成されます。 最初のファイル名は、severity_summary.xml (または.html)、2番目のファイル名は、 severity_summary(1).xml となります。